<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensor.eclipse.event;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    <a name="line.3"></a>
<FONT color="green">004</FONT>    /**<a name="line.4"></a>
<FONT color="green">005</FONT>     * Provides an even listener for the information Eclipse sensor gathers. A client <a name="line.5"></a>
<FONT color="green">006</FONT>     * must implement this class and override the notify method in order to be notified <a name="line.6"></a>
<FONT color="green">007</FONT>     * when a event of action (such as opened<a name="line.7"></a>
<FONT color="green">008</FONT>     * project, closed project, saved file, and so forth) is triggered. the client can know<a name="line.8"></a>
<FONT color="green">009</FONT>     * what kind of even is triggered, checking the even flag of the EclipseSensorEvent instance.<a name="line.9"></a>
<FONT color="green">010</FONT>     * For, example, to check if the event is notified when project is opened, the client <a name="line.10"></a>
<FONT color="green">011</FONT>     * can override the notify method such as:<a name="line.11"></a>
<FONT color="green">012</FONT>     * <a name="line.12"></a>
<FONT color="green">013</FONT>     * &lt;pre&gt;<a name="line.13"></a>
<FONT color="green">014</FONT>     * public void notify (EclispeSensorEvent event) {<a name="line.14"></a>
<FONT color="green">015</FONT>     *   if (event.getEvent() != EclipseSensorEvent.PROJECT_OPEN) {<a name="line.15"></a>
<FONT color="green">016</FONT>     *     return;<a name="line.16"></a>
<FONT color="green">017</FONT>     *   }<a name="line.17"></a>
<FONT color="green">018</FONT>     *   String workspacePath = event.getResource().getWorkspace().getRoot().getLocation().toString();<a name="line.18"></a>
<FONT color="green">019</FONT>     *   IFolder cvsFolder = ((IProject) event.getResource()).getFolder("CVS");<a name="line.19"></a>
<FONT color="green">020</FONT>     *   ...<a name="line.20"></a>
<FONT color="green">021</FONT>     * }<a name="line.21"></a>
<FONT color="green">022</FONT>     * &lt;/pre&gt;<a name="line.22"></a>
<FONT color="green">023</FONT>     * <a name="line.23"></a>
<FONT color="green">024</FONT>     * After implementing the sub class, the client need to add this class to the <a name="line.24"></a>
<FONT color="green">025</FONT>     * &lt;code&gt;org.hackystat.sensor.eclipse.EclipseSensor&lt;/code&gt;. To add the implementing class to<a name="line.25"></a>
<FONT color="green">026</FONT>     * the &lt;code&gt;EclipseSensor&lt;/code&gt;, use &lt;code&gt;EclipseSensor#addEclipseSensorEventListener()&lt;/code&gt;<a name="line.26"></a>
<FONT color="green">027</FONT>     * method such as:<a name="line.27"></a>
<FONT color="green">028</FONT>     * <a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;pre&gt;<a name="line.29"></a>
<FONT color="green">030</FONT>     * EclipseSensor.getInstance().addEclipseSensorEventListener(this);<a name="line.30"></a>
<FONT color="green">031</FONT>     * &lt;/pre&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * <a name="line.32"></a>
<FONT color="green">033</FONT>     * Note that the "this" points to the implementing sub class.<a name="line.33"></a>
<FONT color="green">034</FONT>     * &lt;p&gt;Whenever a new sensor properties is supposed to be read in Eclipse sensor, you must set the <a name="line.34"></a>
<FONT color="green">035</FONT>     * new sensor properties in such a way that :<a name="line.35"></a>
<FONT color="green">036</FONT>     * <a name="line.36"></a>
<FONT color="green">037</FONT>     * &lt;pre&gt;<a name="line.37"></a>
<FONT color="green">038</FONT>     * File sensorPropertiesFile = new File(...);<a name="line.38"></a>
<FONT color="green">039</FONT>     * SensorProperties newProperties = new SensorProperties(EclipseSensor.EclipseSensor.SENSOR_ECLIPSE,<a name="line.39"></a>
<FONT color="green">040</FONT>     *                                                       sensorPropertiesFile);<a name="line.40"></a>
<FONT color="green">041</FONT>     * EclipseSensor.getInstance().setSensorProperties(newProperties);<a name="line.41"></a>
<FONT color="green">042</FONT>     * &lt;/pre&gt;<a name="line.42"></a>
<FONT color="green">043</FONT>     *<a name="line.43"></a>
<FONT color="green">044</FONT>     * @author Takuya Yamashita<a name="line.44"></a>
<FONT color="green">045</FONT>     * @version $Id: IEclipseSensorEventListener.java,v 1.1.1.1 2005/10/20 23:56:57 johnson Exp $<a name="line.45"></a>
<FONT color="green">046</FONT>     */<a name="line.46"></a>
<FONT color="green">047</FONT>    public interface IEclipseSensorEventListener {<a name="line.47"></a>
<FONT color="green">048</FONT>      /**<a name="line.48"></a>
<FONT color="green">049</FONT>       * Provides a notification method to be called when the implementing class is notified.<a name="line.49"></a>
<FONT color="green">050</FONT>       *<a name="line.50"></a>
<FONT color="green">051</FONT>       * @param event The EclipseSensorEvent instance to hold an event information (flag).<a name="line.51"></a>
<FONT color="green">052</FONT>       */<a name="line.52"></a>
<FONT color="green">053</FONT>      void notify(EclipseSensorEvent event);<a name="line.53"></a>
<FONT color="green">054</FONT>    }<a name="line.54"></a>




























































</PRE>
</BODY>
</HTML>
